<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FabGL: ulp_macro_ex.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FabGL
   </div>
   <div id="projectbrief">ESP32 Display Controller and Graphics Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('ulp__macro__ex_8cpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle"><div class="title">ulp_macro_ex.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright 2010-2016 Espressif Systems (Shanghai) PTE LTD</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">//</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">//</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">//     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">//</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// This file is identical to IDF ulp_macro.c, except for redefinition of CONFIG_ULP_COPROC_RESERVE_MEM to allow</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">// larger ULP programs</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#include &lt;string.h&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &lt;stdlib.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;esp_attr.h&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;esp_err.h&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;esp_log.h&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;esp32/ulp.h&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &quot;soc/soc.h&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;soc/rtc_cntl_reg.h&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;soc/sens_reg.h&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#include &quot;sdkconfig.h&quot;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#include &quot;ulp_macro_ex.h&quot;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">// fabgl =&gt;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#undef CONFIG_ULP_COPROC_RESERVE_MEM</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#define CONFIG_ULP_COPROC_RESERVE_MEM 2048</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">// &lt;=</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* TAG = <span class="stringliteral">&quot;ulp&quot;</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>    uint32_t label : 16;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>    uint32_t addr : 11;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>    uint32_t unused : 1;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    uint32_t type : 4;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>} reloc_info_t;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">#define RELOC_TYPE_LABEL   0</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="preprocessor">#define RELOC_TYPE_BRANCH  1</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">/* This record means: there is a label at address</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * insn_addr, with number label_num.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> */</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">#define RELOC_INFO_LABEL(label_num, insn_addr) (reloc_info_t) { \</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">    .label = label_num, \</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">    .addr = insn_addr, \</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">    .unused = 0, \</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="preprocessor">    .type = RELOC_TYPE_LABEL }</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">/* This record means: there is a branch instruction at</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * insn_addr, it needs to be changed to point to address</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * of label label_num.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> */</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#define RELOC_INFO_BRANCH(label_num, insn_addr) (reloc_info_t) { \</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">    .label = label_num, \</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">    .addr = insn_addr, \</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">    .unused = 0, \</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">    .type = RELOC_TYPE_BRANCH }</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">/* Comparison function used to sort the relocations array */</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="keyword">static</span> <span class="keywordtype">int</span> reloc_sort_func(<span class="keyword">const</span> <span class="keywordtype">void</span>* p_lhs, <span class="keyword">const</span> <span class="keywordtype">void</span>* p_rhs)</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>{</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>    <span class="keyword">const</span> reloc_info_t lhs = *(<span class="keyword">const</span> reloc_info_t*) p_lhs;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>    <span class="keyword">const</span> reloc_info_t rhs = *(<span class="keyword">const</span> reloc_info_t*) p_rhs;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>    <span class="keywordflow">if</span> (lhs.label &lt; rhs.label) {</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>        <span class="keywordflow">return</span> -1;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>    } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (lhs.label &gt; rhs.label) {</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>        <span class="keywordflow">return</span> 1;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>    }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>    <span class="comment">// label numbers are equal</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>    <span class="keywordflow">if</span> (lhs.type &lt; rhs.type) {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>        <span class="keywordflow">return</span> -1;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>    } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (lhs.type &gt; rhs.type) {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>        <span class="keywordflow">return</span> 1;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>    }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>    <span class="comment">// both label number and type are equal</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    <span class="keywordflow">return</span> 0;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>}</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">/* Processing branch and label macros involves four steps:</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * 1. Iterate over program and count all instructions</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *    with &quot;macro&quot; opcode. Allocate relocations array</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *    with number of entries equal to number of macro</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *    instructions.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * 2. Remove all fake instructions with &quot;macro&quot; opcode</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> *    and record their locations into relocations array.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *    Removal is done using two pointers. Instructions</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *    are read from read_ptr, and written to write_ptr.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *    When a macro instruction is encountered,</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *    its contents are recorded into the appropriate</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *    table, and then read_ptr is advanced again.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *    When a real instruction is encountered, it is</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *    read via read_ptr and written to write_ptr.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *    In the end, all macro instructions are removed,</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> *    size of the program (expressed in words) is</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *    reduced by the total number of macro instructions</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> *    which were present.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * 3. Sort relocations array by label number, and then</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *    by type (&quot;label&quot; or &quot;branch&quot;) if label numbers</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *    match. This is done to simplify lookup on the next</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> *    step.</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * 4. Iterate over entries of relocations table.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> *    For each label number, label entry comes first</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *    because the array was sorted at the previous step.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *    Label address is recorded, and all subsequent</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *    &quot;branch&quot; entries which point to the same label number</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> *    are processed. For each branch entry, correct offset</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *    or absolute address is calculated, depending on branch</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *    type, and written into the appropriate field of</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *    the instruction.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> */</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="keyword">static</span> esp_err_t do_single_reloc(ulp_insn_t* program, uint32_t load_addr,</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>        reloc_info_t label_info, reloc_info_t branch_info)</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>{</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>    <span class="keywordtype">size_t</span> insn_offset = branch_info.addr - load_addr;</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>    ulp_insn_t* insn = &amp;program[insn_offset];</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>    <span class="comment">// B and BX have the same layout of opcode/sub_opcode fields,</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>    <span class="comment">// and share the same opcode</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>    assert(insn-&gt;b.opcode == OPCODE_BRANCH</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>            &amp;&amp; <span class="stringliteral">&quot;branch macro was applied to a non-branch instruction&quot;</span>);</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>    <span class="keywordflow">switch</span> (insn-&gt;b.sub_opcode) {</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>        <span class="keywordflow">case</span> SUB_OPCODE_STAGEB:</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>        <span class="keywordflow">case</span> SUB_OPCODE_B: {</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>            int32_t offset = ((int32_t) label_info.addr) - ((int32_t) branch_info.addr);</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>ESP_LOGW(TAG, <span class="stringliteral">&quot;%d\n&quot;</span>, offset);</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span>            uint32_t abs_offset = abs(offset);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>            uint32_t sign = (offset &gt;= 0) ? 0 : 1;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>            <span class="keywordflow">if</span> (abs_offset &gt; 127) {</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span>                ESP_LOGE(TAG, <span class="stringliteral">&quot;target out of range: branch from %x to %x&quot;</span>,</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>                        branch_info.addr, label_info.addr);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span>                <span class="keywordflow">return</span> ESP_ERR_ULP_BRANCH_OUT_OF_RANGE;</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>            }</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>            insn-&gt;b.offset = abs_offset;</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>            insn-&gt;b.sign = sign;</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span>            <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>        }</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span>        <span class="keywordflow">case</span> SUB_OPCODE_BX: {</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span>            assert(insn-&gt;bx.reg == 0 &amp;&amp;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>                    <span class="stringliteral">&quot;relocation applied to a jump with offset in register&quot;</span>);</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>            insn-&gt;bx.addr = label_info.addr;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span>            <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>        }</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>        <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span>            assert(<span class="keyword">false</span> &amp;&amp; <span class="stringliteral">&quot;unexpected sub-opcode&quot;</span>);</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span>    }</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>    <span class="keywordflow">return</span> ESP_OK;</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>}</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span> </div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span>esp_err_t ulp_process_macros_and_load_ex(uint32_t load_addr, <span class="keyword">const</span> ulp_insn_t* program, <span class="keywordtype">size_t</span>* psize)</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>{</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>    <span class="keyword">const</span> ulp_insn_t* read_ptr = program;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>    <span class="keyword">const</span> ulp_insn_t* end = program + *psize;</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>    <span class="keywordtype">size_t</span> macro_count = 0;</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>    <span class="comment">// step 1: calculate number of macros</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>    <span class="keywordflow">while</span> (read_ptr &lt; end) {</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>        ulp_insn_t r_insn = *read_ptr;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>        <span class="keywordflow">if</span> (r_insn.macro.opcode == OPCODE_MACRO) {</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>            ++macro_count;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span>        }</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>        ++read_ptr;</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>    }</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>    <span class="keywordtype">size_t</span> real_program_size = *psize - macro_count;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span>    <span class="keyword">const</span> <span class="keywordtype">size_t</span> ulp_mem_end = CONFIG_ULP_COPROC_RESERVE_MEM / <span class="keyword">sizeof</span>(ulp_insn_t);</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>    <span class="keywordflow">if</span> (load_addr &gt; ulp_mem_end) {</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span>        ESP_LOGE(TAG, <span class="stringliteral">&quot;invalid load address %x, max is %x&quot;</span>,</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span>                load_addr, ulp_mem_end);</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>        <span class="keywordflow">return</span> ESP_ERR_ULP_INVALID_LOAD_ADDR;</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span>    }</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>    <span class="keywordflow">if</span> (real_program_size + load_addr &gt; ulp_mem_end) {</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span>        ESP_LOGE(TAG, <span class="stringliteral">&quot;program too big: %d words, max is %d words&quot;</span>,</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>                real_program_size, ulp_mem_end);</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span>        <span class="keywordflow">return</span> ESP_ERR_ULP_SIZE_TOO_BIG;</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span>    }</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span>    <span class="comment">// If no macros found, copy the program and return.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>    <span class="keywordflow">if</span> (macro_count == 0) {</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>        memcpy(((ulp_insn_t*) RTC_SLOW_MEM) + load_addr, program, *psize * <span class="keyword">sizeof</span>(ulp_insn_t));</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>        <span class="keywordflow">return</span> ESP_OK;</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>    }</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span>    reloc_info_t* reloc_info =</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>            (reloc_info_t*) malloc(<span class="keyword">sizeof</span>(reloc_info_t) * macro_count);</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span>    <span class="keywordflow">if</span> (reloc_info == <span class="keyword">nullptr</span>) {</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>        <span class="keywordflow">return</span> ESP_ERR_NO_MEM;</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span>    }</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span> </div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>    <span class="comment">// step 2: record macros into reloc_info array</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span>    <span class="comment">// and remove them from then program</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span>    read_ptr = program;</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span>    ulp_insn_t* output_program = ((ulp_insn_t*) RTC_SLOW_MEM) + load_addr;</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span>    ulp_insn_t* write_ptr = output_program;</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span>    uint32_t cur_insn_addr = load_addr;</div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span>    reloc_info_t* cur_reloc = reloc_info;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span>    <span class="keywordflow">while</span> (read_ptr &lt; end) {</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span>        ulp_insn_t r_insn = *read_ptr;</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span>        <span class="keywordflow">if</span> (r_insn.macro.opcode == OPCODE_MACRO) {</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span>            <span class="keywordflow">switch</span>(r_insn.macro.sub_opcode) {</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span>                <span class="keywordflow">case</span> SUB_OPCODE_MACRO_LABEL:</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>                    *cur_reloc = RELOC_INFO_LABEL(r_insn.macro.label,</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span>                            cur_insn_addr);</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span>                    <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span>                <span class="keywordflow">case</span> SUB_OPCODE_MACRO_BRANCH:</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span>                    *cur_reloc = RELOC_INFO_BRANCH(r_insn.macro.label,</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span>                            cur_insn_addr);</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span>                    <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>                <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span>                    assert(0 &amp;&amp; <span class="stringliteral">&quot;invalid sub_opcode for macro insn&quot;</span>);</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span>            }</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span>            ++read_ptr;</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span>            assert(read_ptr != end &amp;&amp; <span class="stringliteral">&quot;program can not end with macro insn&quot;</span>);</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>            ++cur_reloc;</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span>        } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>            <span class="comment">// normal instruction (not a macro)</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span>            *write_ptr = *read_ptr;</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span>            ++read_ptr;</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span>            ++write_ptr;</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span>            ++cur_insn_addr;</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>        }</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span>    }</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span> </div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span>    <span class="comment">// step 3: sort relocations array</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span>    qsort(reloc_info, macro_count, <span class="keyword">sizeof</span>(reloc_info_t),</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span>            reloc_sort_func);</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span> </div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span>    <span class="comment">// step 4: walk relocations array and fix instructions</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span>    reloc_info_t* reloc_end = reloc_info + macro_count;</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span>    cur_reloc = reloc_info;</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span>    <span class="keywordflow">while</span>(cur_reloc &lt; reloc_end) {</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>        reloc_info_t label_info = *cur_reloc;</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span>        assert(label_info.type == RELOC_TYPE_LABEL);</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>        ++cur_reloc;</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>        <span class="keywordflow">while</span> (cur_reloc &lt; reloc_end) {</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span>            <span class="keywordflow">if</span> (cur_reloc-&gt;type == RELOC_TYPE_LABEL) {</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>                <span class="keywordflow">if</span>(cur_reloc-&gt;label == label_info.label) {</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span>                    ESP_LOGE(TAG, <span class="stringliteral">&quot;duplicate label definition: %d&quot;</span>,</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span>                            label_info.label);</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span>                    free(reloc_info);</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span>                    <span class="keywordflow">return</span> ESP_ERR_ULP_DUPLICATE_LABEL;</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span>                }</div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span>                <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span>            }</div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span>            <span class="keywordflow">if</span> (cur_reloc-&gt;label != label_info.label) {</div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span>                ESP_LOGE(TAG, <span class="stringliteral">&quot;branch to an inexistent label: %d&quot;</span>,</div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span>                        cur_reloc-&gt;label);</div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span>                free(reloc_info);</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span>                <span class="keywordflow">return</span> ESP_ERR_ULP_UNDEFINED_LABEL;</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span>            }</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span>            esp_err_t rc = do_single_reloc(output_program, load_addr,</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span>                    label_info, *cur_reloc);</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>            <span class="keywordflow">if</span> (rc != ESP_OK) {</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span>                free(reloc_info);</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span>                <span class="keywordflow">return</span> rc;</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span>            }</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span>            ++cur_reloc;</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>        }</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>    }</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span>    free(reloc_info);</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span>    *psize = real_program_size;</div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span>    <span class="keywordflow">return</span> ESP_OK;</div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span>}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>ulp_macro_ex.cpp</b></li>
    <li class="footer">Generated on Mon Aug 29 2022 13:52:05 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
  </ul>
</div>
</body>
</html>
